技术方面
- 网络协议方面
确认接口对接的网络协议和请求地址:https/http 端口号 请求地址 - 接口请求方面
尽量全部约定 数据传参+响应格式为:application/json POST请求 - 确认请求参数是否必传以及数据类型,非必传字段需要确认是传null还是空字符串。
- 接口安全方面
考虑是否需要安全考虑,外网一定要有认证机制。参数是否需要加密。
重要
-
【重要】幂等校验方面
确保 本公司接口和三方公司接口都有唯一校验功能,防止重复提交 -
【重要】重试机制方面
一定要确认是否需要接口调用失败后的重试机制,保证数据传输的最终一致性。
重试机制包括 实时重试调用指定次数 + 调用失败持久化数据库定时任务重试 -
自己有对接模拟接口,防止三方公司接口迟迟未完成,影响整个项目进度
-
日志记录
日志记录:请求入参,返回参数,请求url,http响应结果,耗时,请求人信息,请求时间, 都要用日志记录下来,最好能异步落库,方便查看原因
-
事务处理
本地事务成功,但是第三方接口发生异常,导致数据不一致。
- 第三方接口超时问题,需要做服务的降级和熔断
- 异常处理
非技术方面
- 【重要】画出流程时序图
- 【重要】每天查看进度,不能没人管,至少本公司必须有专一团队负责人!
- 查看对方文档,积极沟通
- 本公司接口文档和图发对方确认,一定要对方明确答复
- 团队成员稳定专一
- 如果接口发生变更,要及时更新接口文档
- 接口文档双方确认后,双方严格按照接口文档的格式和要求进行开发,防止事后扯皮。
- 对接沟通时,留好证据,防止对方事后扯皮。
对接风险
对方不配合 (奶茶、香烟给安排上,还不行只能让上级去推动了)
对接要从源头留痕,防止后面对方扯皮,要留证据。(拿证据说话)
对方服务升级,接口变了,未通知升级。(接口版本号制定好,接口做到向下兼容)
对方服务不稳定影响自有系统。(服务熔断、降级处理)
调用并发频率过高等。(控制频率)